Sydney Reticulum Git Mirror

Micron Document

Node / reticulum / reticulum / files / docs / markdown / index.md

Displaying Rendered • View raw • Download

docs/markdown/index.md HEAD (4fc8e03d) Text, 17.00 KB

Reticulum Network Stack Manual

This manual aims to provide you with all the information you need to

understand Reticulum, build networks or develop programs using it, or

to participate in the development of Reticulum itself.

• What is Reticulum?

• Current Status

• Reference Implementation

• What does Reticulum Offer?

• Where can Reticulum be Used?

• Interface Types and Devices

• Getting Started Fast

• Standalone Reticulum Installation

• Resolving Dependency & Installation Issues

• Try Using a Reticulum-based Program

• Using the Included Utilities

• Creating a Network With Reticulum

• Bootstrapping Connectivity

• Finding Your Way

• Build Personal Infrastructure

• Mixing Strategies

• Network Health & Responsibility

• Contributing to the Global Ret

• Connect to the Distributed Backbone

• Hosting Public Entrypoints

• Connecting Reticulum Instances Over the Internet

• Adding Radio Interfaces

• Creating and Using Custom Interfaces

• Develop a Program with Reticulum

• Platform-Specific Install Notes

• Android

• ARM64

• Debian Bookworm

• MacOS

• OpenWRT

• Raspberry Pi

• RISC-V

• Ubuntu Lunar

• Windows

• Pure-Python Reticulum

• Zen of Reticulum

• The Illusion Of The Center

• Fallacy Of The Cloud

• Decentralization Or Uncentralizability?

• Death To The Address

• Physics Of Trust

• Hostile Environments

• Encryption Is Not A Feature

• Zero-Trust Architectures

• Merits Of Scarcity

• The Bandwidth Fallacy

• Cost Of A Byte

• Flow & Time

• Liberation From Limits

• Sovereignty Through Infrastructure

• A Carrier-Grade Fallacy

• Personal Infrastructure

• The Ability To Disconnect

• Identity and Nomadism

• Portable Existence

• Roaming Nodes

• Announcing Presence

• Anchor In The Flow

• Ethics Of The Tool

• The Harm Principle

• Public Domain Protocol

• Preserving Human Agency

• Design Patterns For Post-IP Systems

• Store & Forward

• Naming Is Power

• The Interface Is The Medium

• Emergent Patterns

• Fabric Of The Independent

• The Work Is Finished

• Open Sky

• Programs Using Reticulum

• Programs & Utilities

• Remote Shell

• Nomad Network

• RNS Page Node

• Retipedia

• Sideband

• MeshChatX

• Reticulum Relay Chat

• RetiBBS

• RBrowser

• Reticulum Network Telephone

• LXST Phone

• LXMFy

• LXMF Interactive Client

• RNS FileSync

• Micron Parser JS

• RNMon

• Protocols

• LXMF

• LXST

• RRC

• Interface Modules & Connectivity Resources

• Using Reticulum on Your System

• Configuration & Data

• Included Utility Programs

• The rnsd Utility

• The rnstatus Utility

• The rnid Utility

• The rnpath Utility

• The rnprobe Utility

• The rncp Utility

• The rngit Utility

• The rnx Utility

• The rnsh Utility

• The rnodeconf Utility

• Discovering Interfaces

• Remote Management

• Blackhole Management

• Local Blackhole Management

• Automated List Sourcing

• Publishing Blackhole Lists

• Improving System Configuration

• Fixed Serial Port Names

• Reticulum as a System Service

• Understanding Reticulum

• Motivation

• Goals

• Introduction & Basic Functionality

• Destinations

• Public Key Announcements

• Identities

• Getting Further

• Reticulum Transport

• Node Types

• The Announce Mechanism in Detail

• Reaching the Destination

• Resources

• Network Identities

• Conceptual Overview

• Current Usage

• Future Implications

• Creating and Using a Network Identity

• Reference Setup

• Protocol Specifics

• Packet Prioritisation

• Interface Access Codes

• Wire Format

• Announce Propagation Rules

• Cryptographic Primitives

• Communications Hardware

• Combining Hardware Types

• RNode

• Creating RNodes

• Supported Boards and Devices

• Installation

• Usage with Reticulum

• WiFi-based Hardware

• Ethernet-based Hardware

• Serial Lines & Devices

• Packet Radio Modems

• Configuring Interfaces

• Custom Interfaces

• Auto Interface

• Backbone Interface

• Listeners

• Connecting Remotes

• Automated Blocking

• TCP Server Interface

• TCP Client Interface

• UDP Interface

• I2P Interface

• RNode LoRa Interface

• RNode Multi Interface

• Serial Interface

• Pipe Interface

• KISS Interface

• AX.25 KISS Interface

• Discoverable Interfaces

• Enabling Discovery

• Discovery Parameters

• Interface Modes

• Security Considerations

• Example Configuration

• Common Interface Options

• Interface Modes

• Announce Rate Control

• New Destination Rate Limiting

• Path Request Burst Control

• Building Networks

• Concepts & Overview

• Introductory Considerations

• Destinations, Not Addresses

• Transport Nodes and Instances

• Trustless Networking

• Heterogeneous Connectivity

• Distributed Development

• The Original Architecture

• The Platform Interregnum

• Restoration

• Protocols Over Platforms

• Sovereignty Through Infrastructure

• Artifact-Centered Workflows

• Composable Primitives

• Distribution Without Intermediaries

• Long Archive

• Start Of The Road

• Git Over Reticulum

• The rngit Utility

• Repository Creation & Management

• Creating Empty Repositories

• Forking Repositories

• Mirroring Repositories

• Automatic Mirror Synchronization

• Manual Synchronization

• Git Configuration Parameters

• Repository Structure

• Configuration

• Permissions

• Permission Types

• Permission Hierarchy

• Configuration Methods

• Work Document Permissions

• Creator Permissions

• Permission Examples

• Permission Short Forms

• Permission Configuration Locations

• Remote Permission Management

• Managing Group Permissions

• Managing Repository Permissions

• Permission Validation

• Identity & Destination Aliases

• Serving Pages Over Nomad Network

• Enabling the Git Page Node

• Accessing Repository Pages

• Formatting & Syntax Highlighting

• Customizing Templates

• Repository Statistics

• Configuration Example

• Verified Releases

• Obtaining Verified Releases

• Offline Verification

• Creating Signed Releases

• Release Management

• The Release Workflow

• Release Storage & Structure

• Command-Line Interaction

• Work Documents

• Working With Work Documents

• Proposing Work Documents

• State Management

• Managing Work Document Permissions

• Cryptographic Attribution

• Commit Signing

• Prerequisites

• Configuration

• Author Identity Binding

• Signing Commits

• Validating Commit Signatures

• Support Reticulum

• Donations

• Provide Feedback

• Code Examples

• Minimal

• Announce

• Broadcast

• Echo

• Link

• Identification

• Requests & Responses

• Channel

• Buffer

• Filetransfer

• Custom Interfaces

• Reticulum License

• API Reference

• Reticulum

• Identity

• Destination

• Packet

• PacketReceipt

• Link

• RequestReceipt

• Resource

• Channel

• MessageBase

• Buffer

• RawChannelReader

• RawChannelWriter

• Transport

Served by rngit 1.4.2 - Generated in 0.06s